IviACPwr Query Current Protection Tripped [CP] VI
IviACPwrCurrentProtection Capability Group
This VI returns the current protection state of the AC power source.
Current protection trips when the output current exceeds the value of the IviACPwr Current Protection Threshold [CP] property for the time specified by the IviACPwr Current Protection Delay [CP] property and the IviACPwr Current Protection Enabled [CP] property is set to True.
When current protection trips, the power source enters the current protection state and disables the output. The user must call the IviACPwr Reset Current Protection [CP] VI to reset the current protection state of the AC power source. Once current protection is reset, the user must then set the IviACPwr Output Enabled property to True for the AC power source to resume generating output current.
instrument handle The instrument handle that you obtain from the IviACPwr Initialize or IviACPwr Initialize With Options VIs. The handle identifies a particular instrument session.
Default Value: None |
|
Phase Name ("") Specifies the name of the output phase to query.
Pass the virtual output phase name that you assign to the instrument in the IVI Configuration utility. Virtual output phase names are aliases for instrument-specific output phase strings, which can differ from one instrument to another. With virtual output phase names, you can use and swap instruments without having to change the output phase names in your source code. Assign a virtual output phase name to an instrument-specific output phase through the IVI Configuration utility. This control accepts virtual output phase names you have assigned to the specific instrument you are using and also accepts the instrument-specific output phase names. Default Value: "" Note: You can specify the output phase name as a string variable or as a literal enclosed in double quotes. |
|
error in (no error) The error in cluster can accept error information wired from VIs previously called. Use this information to decide if any functionality should be bypassed in the event of errors from other VIs.
The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed. |
|
instrument handle out The instrument handle that you obtain from the IviACPwr Initialize or IviACPwr Initialize With Options VIs. | |
Tripped Returns True if current protection has tripped. | |
error out The error out cluster passes error or warning information out of a VI to be used by other VIs.
The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed. |